Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: new repo #888

Merged
merged 11 commits into from
Nov 8, 2024
Merged

docs: new repo #888

merged 11 commits into from
Nov 8, 2024

Conversation

Real-MullaC
Copy link
Contributor

@Real-MullaC Real-MullaC commented Oct 31, 2024 •
edited
Loading

Make docs URL first like sent in dms!

https://github.com/Chris-Titus-Docs/linutil-docs - New docs repo

Type of Change

  • New feature
  • Bug fix
  • Documentation update
  • Refactoring
  • Hotfix
  • Security patch
  • UI/UX improvement

Description

New docs layout and repo

Testing

All works locally on new repo but none needed here.

Impact

None

Issues / other PRs related

  • Resolves no issues

Additional Information

No

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no errors/warnings/merge conflicts.

@jeevithakannan2
Copy link
Contributor

jeevithakannan2 commented Oct 31, 2024 •
edited
Loading

@Real-MullaC The preview path in the workflow needs to be updated also

adamperkowski
adamperkowski reviewed Oct 31, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@adamperkowski
Copy link
Collaborator

@Real-MullaC You also need to create a workflow to automatically update userguide in the other repo. cargo xtask docgen

@ChrisTitusTech @adamperkowski
Update README.md
5876157 
Co-authored-by: Adam Perkowski <[email protected]>
@Real-MullaC
Copy link
Contributor Author

@Real-MullaC The preview path in the workflow needs to be updated also

What workflow?

@adamperkowski adamperkowski changed the title Changed docs repo docs: new repo Oct 31, 2024
@adamperkowski adamperkowski added the documentation Improvements or additions to documentation label Oct 31, 2024
@adamperkowski
Copy link
Collaborator

@Real-MullaC The preview path in the workflow needs to be updated also

What workflow?

There is none yet. You have to make one. When someone edits tab_data it needs to run cargo xtask docgen and commit the changes to the other repos

@Real-MullaC
Copy link
Contributor Author

@Real-MullaC The preview path in the workflow needs to be updated also

What workflow?

There is none yet. You have to make one. When someone edits tab_data it needs to run cargo xtask docgen and commit the changes to the other repos

Done both issues

adamperkowski
adamperkowski approved these changes Nov 2, 2024
View reviewed changes
Copy link
Collaborator

@adamperkowski adamperkowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ChrisTitusTech don't forget the workflow

This was referenced Nov 8, 2024
Merged
Merged
Merged
Open
@ChrisTitusTech ChrisTitusTech merged commit 76f8e64 into ChrisTitusTech:main Nov 8, 2024
1 check passed
jeevithakannan2 pushed a commit to jeevithakannan2/linutil that referenced this pull request Nov 11, 2024
@Real-MullaC @ChrisTitusTech
@adamperkowski @jeevithakannan2
docs: new repo (ChrisTitusTech#888)
a6bd6ec 
* Removes docs and mentions on readme

* Update README.md

* Update README.md

Co-authored-by: Adam Perkowski <[email protected]>

* Update linutil.yml

* Delete xtask.yml

* Update preview.yml

* Update README.md

---------

Co-authored-by: Chris Titus <[email protected]>
Co-authored-by: Adam Perkowski <[email protected]>
@jeevithakannan2 jeevithakannan2 mentioned this pull request Nov 13, 2024
Merged
5 tasks
@solomoncyj
Copy link
Contributor

solomoncyj commented Jan 13, 2025 •
edited
Loading

can someone explain the rational for the favicon removal? it is used as the desktop icon for the application for some distrubutions @Real-MullaC

@Real-MullaC
Copy link
Contributor Author

can someone explain the rational for the favicon removal? it is used as the desktop icon for the application for some distrubutions @Real-MullaC

It will need adding back then. As we moved docs to a new repo.

@solomoncyj
Copy link
Contributor

Maybe we should submodule the docs repo into here and delete the repo submodule in the docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adamperkowski adamperkowski adamperkowski approved these changes

@ChrisTitusTech ChrisTitusTech ChrisTitusTech approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Real-MullaC @jeevithakannan2 @adamperkowski @solomoncyj @ChrisTitusTech